getDistanceMatrix

getDistanceMatrix

Query Parameters

fromDealerShip boolean

fromDealerShip

Header Parameters

authorization string required

authorization

application/json

Request Body required

request

dealerDepartmentUuidList string[]
destinations object[]
Array [
latitude string
longitude string
metaData object
data string
type string
Possible values: [QUERY_LOCATION, DEALERSHIP_ADDRESS, APPOINTMENT_LOCATION]
]
origins object[]
Array [
latitude string
longitude string
metaData object
data string
type string
Possible values: [QUERY_LOCATION, DEALERSHIP_ADDRESS, APPOINTMENT_LOCATION]
]
requesterUserUuid string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

destinations object[]
Array [
latitude string
longitude string
metaData object
data string
type string
Possible values: [QUERY_LOCATION, DEALERSHIP_ADDRESS, APPOINTMENT_LOCATION]
]
distanceTimeFromOrigins object[]
Array [
distanceTimeToDestination object[]
Array [
distanceInMeters int64
status string
timeInSeconds int64
]
]
error object
code string
description string
metadata object
property name* string
origins object[]
Array [
latitude string
longitude string
metaData object
data string
type string
Possible values: [QUERY_LOCATION, DEALERSHIP_ADDRESS, APPOINTMENT_LOCATION]
]
statusCode int32
warnings object[]
Array [
code string
description string
]

{
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "distanceTimeFromOrigins": [
    {
      "distanceTimeToDestination": [
        {
          "distanceInMeters": 0,
          "status": "string",
          "timeInSeconds": 0
        }
      ]
    }
  ],
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "statusCode": 0,
  "warnings": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /location/distance

Request

Base URL

//api.mykaarma.com/mobile-service

authorization — header required

fromDealerShip — query

---truefalse

Body required

{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

go / native

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/mobile-service/location/distance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUuidList": [
    "string"
  ],
  "destinations": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "origins": [
    {
      "latitude": "string",
      "longitude": "string",
      "metaData": {
        "data": "string",
        "type": "QUERY_LOCATION"
      }
    }
  ],
  "requesterUserUuid": "string"
}'